Inside Macintosh: Mac OS 8 Toolbox Reference /

Chapter 7 - Finder Interface Reference / Finder Interface Functions

Manipulating Folder Descriptors /

GetFolderDescriptor

NEW WITH MAC OS 8

Gets the folder descriptor information for the specified folder type from the global descriptor list.

pascal OSErr GetFolderDescriptor (
                     FolderType foldType,
                     Size descSize,
                     FolderDesc *foldDesc);

foldType

A constant identifying the type of the folder for which you wish to get descriptor information. See "Folder Type Constants".

descSize

Input the size (in bytes) of the folder descriptor structure.

foldDesc

On input, a pointer to the folder descriptor structure. On output, a pointer to a filled-out folder descriptor structure.

function result

A result code; see "Result Codes".

DISCUSSION

The GetFolderDescriptor function provides a pointer to a filled-out folder descriptor structure.

SPECIAL CONSIDERATIONS

Before calling the GetFolderDescriptor function, you must pass the selector gestaltFindFolderAttr to the Gestalt function. If the gestaltFolderDescSupport bit is set, GetFolderDescriptor is available.